IBM Endpoint Manager Inspectors Reference

Terminology

Win: Windows
Lin: Red Hat and SUSE Linux
Sol: SUN Solaris
HPUX: Hewlett-Packard UNIX version
AIX: IBM AIX
Mac: Apple Macintosh
Ubu: Ubuntu/Debian
WM: Windows Mobile

The version (e.g. Lin:8.1) corresponds to the version of the IEM product (8.1) in which the inspector was introduced in the client on that platform.
The version number is not shown if it is less than 8.0.


Platform


Contents

Action Objects
Authorization Objects
Client Objects
Directory Services
Environment Objects
Filesystem Objects
application
bundle
component
country
datafork
device file
dictionary
dictionaryentry
domain
download storage folder
drive
fifo file
file
file content
file line
file section
file shortcut
file signature
file type
file version block
fileset
filesystem
filesystem object
folder
logical volume
logical volume manager
mode
mode_mask
osxvalue
preference
resfork
socket file
stage
strverscmp version
symlink
version
version with multiplicity
volume
volume group
xml dom node
Firewall Objects
Fixlet Objects
Formatting Objects
Installed System Software
Introspectors
License Objects
Microsoft IIS Metabase Objects
Miscellaneous
Networking Objects
Power Objects
Primitive Objects
Registry Objects
Session Objects
Session Statistics
Site Objects
SMBIOS objects
System Objects
Task Objects
User Objects
Windows Mobile Device Objects
WMI Objects
World Objects

IBM Endpoint Manager wiki

Filesystem Objects

This chapter covers the keywords for extracting information from the file system, like files, drives, pathnames, folders, etc. It also includes the keywords needed to identify and compare version information of files and patches.For more information on special Windows folders, see the Resources section at the end of this guide.

filesystem

The filesystem object can be used to inspect various aspects of mounted file systems, including the format of the file system. Here are some of the possible format types:affsext, ext2, ext2_oldhpfsisominix, minix_30, minix2, minix2_30 msdos ncpnfsprocsmbxenixsysv4, sysv2cohufsxia

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

filesystem object

The <filesystem object> Inspectors provide handles for the various objects available in the file system.

Creation Methods

DeclarationDescriptionPlatforms (?)

Operators

DeclarationReturn TypeDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)
<filesystem object> as string<string>Casts a filesystem object as a string.Win:8.0, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
accessed time of <filesystem object><time>

Plural: accessed times
When the filesystem object (file or folder) was last accessed. Some file systems maintain this property.Win, Lin, Sol, HPUX, AIX, WM, Ubu:8.1
ancestor of <filesystem object><folder>

Plural: ancestors
Returns all ancestor folders (recursive parent folders) of the given filesystem object (file or folder).Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
archive of <filesystem object><boolean>

Plural: archives
Returns TRUE if the Archive bit is turned on for the specified file or folder (filesystem object). This bit is often used by backup software.Win, WM
compressed of <filesystem object><boolean>

Plural: compresseds
Returns TRUE if the file or folder (filesystem object) has been compressed.Win, WM
creation time of <filesystem object><time>

Plural: creation times
The date and time of creation of the specified file or folder. This corresponds to what is shown in the "Get Info" box.Win, Mac, WM
drive of <filesystem object><drive>

Plural: drives
Returns the drive associated with the specified file or folder (filesystem object).Win, WM
hidden of <filesystem object><boolean>

Plural: hiddens
Returns TRUE if the file or folder (filesystem object) is marked as hidden.Win, WM
location of <filesystem object><string>

Plural: locations
Returns the name of the directory in which the file or folder (filesystem object) is located.Win, Lin, Sol, HPUX, AIX, WM, Ubu:8.1
modification time of <filesystem object><time>

Plural: modification times
The date and time of latest modification of the file. This corresponds to what is shown in the "Get Info" box.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
name of <filesystem object><string>

Plural: names
This returns the name of the file or folder.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
normal of <filesystem object><boolean>

Plural: normals
Returns TRUE if the file or folder (filesystem object) is 'normal'.Win, WM
offline of <filesystem object><boolean>

Plural: offlines
Returns TRUE if the file or folder (the filesystem object) is marked as 'offline'.Win, WM
parent folder of <filesystem object><folder>

Plural: parent folders
The folder containing the specified file or folder.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
pathname of <filesystem object><string>

Plural: pathnames
Returns the full pathname of the specified file or folder (filesystem object) as a string.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
readonly of <filesystem object><boolean>

Plural: readonlys
Returns TRUE if the file or folder (the filesystem object) is marked as read-only.Win, WM
system of <filesystem object><boolean>

Plural: systems
Returns TRUE if the file or folder (the filesystem object) is marked as a system folder.Win, WM
temporary of <filesystem object><boolean>

Plural: temporarys
Returns TRUE if the file or folder (the filesystem object) is marked as a temporary folder.Win, WM

file

For each file in the file system, you can create a corresponding file object and inspect its properties. Inspectors are also provided to look at version data of executable files.Note: File systems that do not maintain the creation or last accessed times will often return the last modification time when queried for the creation or last accessed times or files. Modification times are preserved when files are copied. Thus, it is not uncommon to see a file that appears to have been modified before it was created.

Creation Methods

DeclarationDescriptionPlatforms (?)
active device fileUnder Windows NT, returns a list of file objects corresponding the list returned from the Windows NT EnumDeviceDrivers() function.Win
active device file <string>Under Windows NT, returns a file object corresponding to the name provided. See file.Win
download file <string>This inspector is available in relevance subsitution action processing. It returns a file object with the given name from the named folder or the download folder. This is equivalent to 'file "name" of download folder'. The file should exist or the result will not exist.

Example:
wait "{pathname of download file "update.exe"}" - In an Action script, this line causes the BES Client to perform relevance substitution to compute the full path to the downloaded file (previously collected by a download command in the same Action script). After relevance substitution, the Client launches the specified executable and waits for it to complete before moving on to other Action lines.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
file <string>Returns a filesystem object corresponding to the full pathname provided in <string>.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
system file <string>Returns a file object corresponding to the relative pathname provided.Win, WM
system ini device fileReturns a list of file objects corresponding to all the device files loaded as a result of a device= lines of the system.ini file. See file.Win
system ini device file <string>Returns a file object corresponding to a device file loaded as a result of a device= line of the system.ini file.Win
windows file <string>Returns a file object corresponding to the relative pathname (within the Windows folder) provided. See file.

Example:
exists windows file "command.com" - Verifies the existence of the named file in the Windows folder.
Win, WM
x32 file <string>Returns an object corresponding to a 32 bit file with name specified by <string>.Win
x64 file <string>Returns an object corresponding to a 64 bit file with pathname specified by <string>. On a 32-bit computer, this is equivalent to a normal file Inspector, but on a 64-bit machine, this Inspector returns an object that has filesystem redirection disabled.Win
<registry key value> as system x32 fileIf the value contains a string and the string points to an file, a file object is returned. Relative paths are interpreted relative to the x32 system folder. Win:9.0
<registry key value> as system x64 fileIf the value contains a string and the string points to an file, a file object is returned. Relative paths are interpreted relative to the x64 system folder. Win:9.0
<registry key value> as fileIf the data stored in the value is a string and it is the full pathname of a file that exists on disk, the file object is returned.Win, WM
<registry key value> as system fileIf the data stored in the value is a string and it is a relative pathname from the system folder of a file that exists on disk, the corresponding file object is returned.Win, WM
descendant of <folder>Returns a list of all the descendant files of the specified folder.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
file <string> of <folder>Returns a file object for the named file located in the folder.

Example:
exists file whose (name of it contains ".pdf") of folder "name" - Returns TRUE if some file in the folder has a name including the string ".pdf".
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
file of <folder>Iterates through the files of a folder returning file objects. When combined with a whose clause you can select files with specific properties. See file.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
find file <string> of <folder>Iterates through the files of a folder returning file objects whose name matches the wildcard string provided in the name parameter. A wildcard string uses an asterisk to stand for any number of characters (incuding zero), and a question mark to stand for exactly one character. Thus A??.txt would match All.txt and AXE.txt but not all.txt or a.txt. See example below.

Example:
Number of find files "siteico*.bmp" of client folder of current site = 3 - Returns TRUE if there are 3 files matching the wildcard pattern siteico*.bmp.

Example:
names of find files "*.exe" of windows folder - Returns a list of the names of all the executable programs in the Windows folder.
Win, Lin, Sol, HPUX, AIX, Mac:8.0, WM, Ubu:8.1
file of <service>Returns a file object corresponding to the specified <service>.Win
image file of <process>Returns a file object representing the image file used to launch the process. In some cases, this subproperty may not exist. For example, the "System" process does not have an image file.Win:8.0
masthead of <site>Each site has a masthead, and the masthead is saved into the site data folder upon successful creation. This property returns a file object that corresponds to the copy in the site data folder.

Example:
modification time of masthead of current site < time "4 Aug 1997 01:00 pdt" - Returns TRUE if the masthead of the current site is older than the specified date.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

Properties

DeclarationReturn typeDescriptionPlatforms (?)
md5 of <file><string>

Plural: md5s
Returns the md5 of the file, hex encoded as a stringUbu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0
sha2_224 of <file><string>

Plural: sha2_224s
Returns the sha2-224 of the file, hex encoded as a stringUbu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0
sha2_256 of <file><string>

Plural: sha2_256s
Returns the sha2-256 of the file, hex encoded as a stringUbu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0
sha2_384 of <file><string>

Plural: sha2_384s
Returns the sha2-384 of the file, hex encoded as a stringUbu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0
sha2_512 of <file><string>

Plural: sha2_512s
Returns the sha2-512 of the file, hex encoded as a stringUbu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0
<file> as string<string>Creates a string containing the full pathname of the specified file. See <file>.Win, Lin, Sol, HPUX, AIX, WM
byte <integer> of <file><integer>

Plural: bytes
Returns the numeric value of the byte located at the offset specified by number within the file. Byte 0 of the file is the first byte.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
content of <file><file content>

Plural: contents
Returns an object that can be used to search for a string in the file. See content.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
drive of <file><filesystem>

Plural: drives
Returns the drive associated with the specified file. On Macintosh computers, this returns a <volume> object.On *nix computers, this returns a <filesystem> object.Win, Lin, Sol, HPUX, AIX, Ubu:8.1
executable file format of <file><string>

Plural: executable file formats
Returns a four-byte string containing the format specifier for the specified file.Win, WM
file version of <file><version>

Plural: file versions
Returns the file version extracted from the file's resource block. See version.Win, WM
first raw version block of <file><file version block>

Plural: first raw version blocks
Returns the first version block directly from a PE file. If the first block is sufficient for your purposes, use this version inspector for best speed.Win, WM
key <string> of <file><string>

Plural: keys
Returns a key and its value from the given structured text file. It iterates over lines that start with the key name (as specified by <string>) followed by an = or : character. When searching, white space is ignored.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
line <integer> of <file><file line>

Plural: lines
Returns the nth line (specified by <integer>) from the given file.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
line containing <string> of <file><file line>

Plural: lines containing
Returns all lines from the given file that contain the specified string.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
line of <file><file line>

Plural: lines
Iterates over all the lines of the specified file. Note that the lines are truncated to 1023 characters.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
line starting with <string> of <file><file line>

Plural: lines starting with
Same as line <string> of <file>, returns the lines of the given file that start with the specified string.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
only raw version block of <file><file version block>

Plural: only raw version blocks
Returns the only version block directly from a PE file.Win, WM
only version block of <file><file version block>

Plural: only version blocks
Most files only have 1 version block. This property allows language independent access when there is only one version block present. The result is the same as 'version block 1'.Win, WM
pem encoded certificate of <file><x509 certificate>

Plural: pem encoded certificates
Reads and returns the certificate from a file in the PEM format. This can be used to analyze encryption credentials on decrypting relays or root servers.Win, WM
product version of <file><version>

Plural: product versions
Returns the product version extracted from the file's resource block. See version.Win, WM
raw file version of <file><version>

Plural: raw file versions
Returns the file version directly from a PE file.Win, WM
raw product version of <file><version>

Plural: raw product versions
Returns the product version directly from a PE file.Win, WM
raw version block <integer> of <file><file version block>

Plural: raw version blocks
Returns the numbered version block directly from a PE file.Win, WM
raw version block <string> of <file><file version block>

Plural: raw version blocks
Returns the named version block directly from a PE file.Win, WM
raw version block of <file><file version block>

Plural: raw version blocks
Returns the version block directly from a PE file.Win, WM
raw version of <file><version>

Plural: raw versions
Returns the version directly from a PE file.Win, WM
section <string> of <file><file section>

Plural: sections
Returns a named section of a file. Useful for locating sections of 'ini' files. Section names are delimited by square bracket characters '[section name]'. See examples below.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
security descriptor of <file><security descriptor>

Plural: security descriptors
Specifies the security descriptor associated with the specified file.Win
sha1 of <file><string>

Plural: sha1s
Returns the sha1 checksum of the file hex encoded as a 40 character long string.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
shortcut of <file><file shortcut>

Plural: shortcuts
Returns the properties and locates the target of a file shortcut:pathname (string)start in pathname (string)argument string (string)icon pathname (string)icon index (integer).Win
size of <file><integer>

Plural: sizes
Returns the size in bytes of a file.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
variable of <file><string>

Plural: variables
Returns the names of variables contained in an INF style file, in the format [section].name=value.Win, Lin, Sol, HPUX, AIX, WM, Ubu:8.1
version block <integer> of <file><file version block>

Plural: version blocks
You can identify the particular version block you want to access by ordinal number.Win, WM
version block <string> of <file><file version block>

Plural: version blocks
You can identify the particular version block you are looking up by name. The name you provide should match the id string of the version block.Win, WM
version block of <file><file version block>

Plural: version blocks
Iterates through the version blocks of a file.Win, WM
version of <file><version>

Plural: versions
Synonym for file version of <file>.Win, Mac, WM
xml document of <file><xml dom document>

Plural: xml documents
Returns an XML Document Object Model (DOM) for the specified file.Win, WM

application

Application objects derive from file objects. Therefore, application objects inherit all of the properties of the file object. This means that you can inspect properties such as 'modification time' or 'Product Version' of an application just as you would a file. See the properties of a file object for a complete list of these. The real power and primary purpose of the application object is their creation. The creation methods are optimized in anticipation of the importance of this object.Note: See File' for a list of the Application properties. Folder and file names may be case sensitive. Use "as uppercase" or "as lowercase" if you don't know the actual case when making comparisons. For Windows versions of these Inspectors, a properly installed application will register itself with the operating system. It does this by creating a registry sub-key usually named after the executable. The regapp Inspector uses the default value of this sub-key as a string that is the full pathname of the executable.

Creation Methods

DeclarationDescriptionPlatforms (?)
application <string>Returns an application for the name provided. On a Macintosh, this Inspector may return a filesystem object.

Example:
application "qna.exe" of parent folder of application "bigfix.exe" of the registry - Using the application of folder creation method, this example locates the 'sibling' application qna.exe provided it exists in the same folder in which the registered application 'bigfix.exe' is installed.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
default web browserReturns the application currently associated with HTML files. This is a Windows Inspector; it will fail gracefully under other operating systems, rather than generate an error. When the agent is a service under windows, it runs in the LocalSystem context.

Example:
default web browser - Returns a value such as: "iexplore.exe" "" "" "" "".
Win
recent applicationReturns all the application objects that have recently been executing on the machine. See application.Win, Lin, Sol:8.1, WM, Ubu:8.1
recent application <string>Returns an application for the name provided it has recently executed. The name is assumed to be the last part of an executable file name.Win, Lin, Sol:8.1, WM, Ubu:8.1
regappThis Inspector returns the applications available to the Client. On Windows systems, this Inspector returns all the application objects defined under the 'App Paths' key of the registry. On a Macintosh, it recursively finds all applications (bundles) and executables under the /Applications directory, as well as all of those under the Applications directories of all local users of the machine. It returns a <filesystem object>. This Inspector is the same as application, and is included for compatibility with Windows.

Example:
names of regapps - Primarily used in QnA to obtain lists of applications installed under the "app path" key of the registry.
Win, Mac, WM
regapp <string>Returns an application object for the name provided. See application and regapp.

Example:
byte 0 of regapp "bigfix.exe" = 77 - TRUE if the first byte in the specified file is ASCII 77.

Example:
regapp "IEXPLORE.EXE" - Returns the application object associated with the named registry key. Checks to see if the executable exists and if so, returns the application object. Case is ignored.
Win, WM
running applicationReturns all the application objects that are currently executing on the machine. See application.

Example:
exists running application whose (name of it as lowercase is "winword.exe") - Returns TRUE if Microsoft Word is currently executing.
Win, Lin, Sol:8.1, WM, Ubu:8.1
running application <string>Returns an application for the name provided it is currently executing. The name is assumed to be the last part of an executable file name.Win, Lin, Sol:8.1, WM, Ubu:8.1
x32 application <string>Returns an object corresponding to the 32-bit application specified by <string>.Win
x64 application <string>Returns an object corresponding to the 64-bit application specified by <string>. On a 32-bit computer, this is equivalent to a normal application Inspector, but on a 64-bit machine, this Inspector returns an object that has filesystem redirection disabled.Win
application <string> of <registry>Returns an application object matching name provided. See application.Win, WM
application of <registry>Iterates through the properly installed applications. See application.

Example:
name of application of key ".txt" of key "HKEY_CLASSES_ROOT" of the registry = "NOTEPAD.EXE" - True when text files are to be opened with notepad.exe on the current machine.
Win, WM
application <string> of <registry key>Returns the application associated with the named command. Normally used with a sub-key of key HKEY_CLASSES_ROOT whose name is a file type.

Example:
application "print" of key "HKEY_CLASSES_ROOT\.txt" of registry - Returns the application designated to print the files with ".txt" extensions.

Example:
application "bigfix.exe" of the registry as string - Results in a string of the form "BigFix.exe" "1.0.32.0" "BigFix Client Application" "1.0.32.0" "BigFix Inc.".
Win, WM
application of <registry key>Returns the application associated with the "open" command. Normally used with a sub-key of key HKEY_CLASSES_ROOT whose name is a file extension.

Example:
name of application of key ".txt" of key "HKEY_CLASSES_ROOT" of the registry = "NOTEPAD.EXE" - True when text files are to be opened with notepad.exe on the current machine.
Win, WM
<registry key value> as applicationIf the data stored in the value is a string and it is the full pathname of an application that exists on disk, the application object is returned.Win, WM
application <string> of <folder>Returns an application object for the named file located in the folder. See application.

Example:
exists application "notepad.exe" of the windows folder - Using the application of folder creation method, this example locates the notepad application provided it exists in the Windows folder.
Win, Lin, Sol, HPUX, AIX, WM, Ubu:8.1

Properties

DeclarationReturn typeDescriptionPlatforms (?)
inspectability of <application><boolean>

Plural: inspectabilities
Win:8.2
task name of <application><string>

Plural: task names
Win:8.2
virtualizer of <application><string>

Plural: virtualizers
Win:8.2

folder

For every folder that exists in the file system, you can create a folder object. These Inspectors allow you to examine dozens of properties of folder objects. On the Macintosh, there are dozens of specialized folders; access to them depends on the domain. If the domain is not specified, it defaults to the system domain.

Creation Methods

DeclarationDescriptionPlatforms (?)
csidl folder <integer>Returns the csidl folder corresponding to the specified integer. The windows SHGetSpecialFolderLocation API is used to look up paths to special folders, which are identified by passing the specified integer as the second argument of the API call. These values and their meaning are described in the windows ShlObj.h include file found in the development sdk.Note that some of these folders do not exist in the Local System context.

Example:
pathname of csidl folder 26 - Returns the path corresponding to CSIDL folder 26 (the application shared data folder, CSIDL_APPDATA).
Win, WM
download folderThis inspector is available in relevance subsitution action processing. When the action is active, this inspector returns a folder object of __Download\, otherwise it returns a folder object of __Global\sitename\actionid\named. This inspector is designed for the prefetch process of action execution. Macintosh Note: Prior to version 7.2, this Inspector referred to the system download folder on the Macintosh. That Inspector is referred to as ISS Download as of version 7.2.

Example:
wait "{pathname of file "update.exe" of download folder}" - In an Action script, this line causes the BES Client to perform relevance substitution to compute the full path to the downloaded file (previously collected by a download command in the same Action script). After relevance substitution, the Client launches the specified executable and waits for it to complete before moving on to other Action lines.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.2
folder <string>Returns a folder object for the name provided. See drive.

Example:
exists folder "c:\program files" - Checks for the existence of the program files folder.

Example:
exists folder "/usr/lib" - Checks for the existence of the usr/lib folder.

Example:
exists folder "/usr/lib" - Checks for the existence of the usr/lib folder.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
install folder <integer>Returns a folder object corresponding to the number provided. The placement of some system folders can be found using numbers that have been associated with those folders. See folder.

Example:
install folder 11 - Returns a folder object for system folder identified with this number.
Win, WM
system wow64 folderReturns a filesystem object corresponding to a "Windows On Windows 64" system folder, which does not exist on 32-bit Windows. You can find out more about the WOW64 system folder at the Microsoft site: http://msdn.microsoft.com/library/default.asp?url=/library/en-us/sysinfo/base/getsystemwow64directory.asp.Win, WM
system x32 folderReturns a filesystem object corresponding to a 32-bit system folder. On a 32-bit machine, this is equivalent to the normal system folder.Win, WM
system x64 folderReturns a filesystem object corresponding to a 64-bit system folder. This is the same as the system folder, but with file system redirection disabled. For more information about file redirection, see the Microsoft site http://msdn.microsoft.com/library/default.asp?url=/library/en-us/win64/win64/file_system_redirector.asp.Win, WM
windows folderReturns a folder object of the Windows folder This is operating system dependent. Under Win98 this is usually c:\Windows.Win, WM
x32 folder <string>Returns a filesystem object corresponding to a 32-bit folder.Win
x64 folder <string>Returns a filesystem object corresponding to a 64-bit folder with the given pathname. On a 32-bit computer, this is equivalent to a normal folder Inspector, but on a 64-bit machine, this Inspector returns an object that has filesystem redirection disabled. This action is transitive: any resulting filesystem objects will also have redirection disabled. For example, "pathnames of files of x64 folder <path>" will disable redirection when locating the folder, iterating over the files in the folder and calculating pathnames.Win
application folder <string> of <registry>Returns the folder containing the matching name provided. See application. The application does not have to exist. The folder has to exist.Win, WM
application folder <string> of <registry key>Returns the parent folder associated with the named application. Normally used with a sub-key of key HKEY_CLASSES_ROOT whose name is a file type.Win, WM
application folder of <registry key>Returns the parent folder associated with the named application. Normally used with a sub-key of key HKEY_CLASSES_ROOT whose name is a file type.Win, WM
<registry key value> as folderIf the data stored in the value is a string and it is the full pathname of a folder that exists on disk, the folder object is returned.Win, WM
ancestor of <filesystem object>Returns all ancestor folders (recursive parent folders) of the given filesystem object (file or folder).Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
parent folder of <filesystem object>The folder containing the specified file or folder.

Example:
posix paths of items whose (name of it starts with "i") of applications folder - Returns a list of the paths of applications starting with "i", such as /Applications/iCal.app, /Applications/iChat.app or /Applications/iTunes.app.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
descendant folder of <folder>Returns the descendant folders, recursively, of the given folder. The folder equivalent of "descendants of <folder>".Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
find folder <string> of <folder>Finds the folder with the given wildcard name inside another folder. A wildcard string uses an asterisk to stand for any number of characters (incuding zero), and a question mark to stand for exactly one character. Thus A??.txt would match All.txt and AXE.txt but not all.txt or a.txt.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
folder <string> of <folder>Returns a folder object for the named sub-folder. Trailing slashes should be omitted from the name.

Example:
exists folder "fonts" of the windows folder - Returns TRUE if fonts is a subdirectory of the Windows directory.

Example:
exists folder "tmp" of root folder - Returns TRUE if tmp is a subdirectory of the root directory.

Example:
exists folder "tmp" of root folder - Returns TRUE if tmp is a subdirectory of the root directory.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
folder of <folder>Iterates through the folders of a folder returning folder objects. When combined with a whose clause, you can select folders with specific properties.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
folder <string> of <drive>Returns a folder object corresponding to the name given provided that folder exists on the drive.Win, WM
root folder of <drive>Returns the folder corresponding to the root of the drive.Win, WM
client folder of <site>The folder containing the site content on the client machine. Site content is gathered into this location.

Example:
exists file "siteicon.bmp" of client folder of current site - TRUE if the specified file exists in the client folder.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
data folder of <client>Returns the __BESData folderUbu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0

Properties

DeclarationReturn typeDescriptionPlatforms (?)
system folderfolder

Plural: system folders
Windows systems, returns the 32 bit "System32" folder. eg: C:\Windows\System32 or C:\Windows\SysWow64. Platforms other than Windows this is a synonym for <root folder>Ubu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0
program files folderfolder

Plural: program files folders
Returns the 32 bit program folder correct for the OS. On 64 bit this is C:\Program Files (x86) and 32 bit it is C:\Program FilesWin:9.0
program files x32 folderfolder

Plural: program files x32 folders
Returns the 32 bit program folder correct for the OS. On 64 bit this is C:\Program Files (x86) and 32 bit it is C:\Program FilesWin:9.0
program files x64 folderfolder

Plural: program files x64 folders
Returns the 64 bit program folder on a 64 bit OS. Returns an error on a 32 bit OS.Win:9.0
application <string> of <folder><application>

Plural: applications
Returns an application object for the named file located in the folder. See application.Win, Lin, Sol, HPUX, AIX, WM, Ubu:8.1
descendant folder of <folder><folder>

Plural: descendant folders
Returns the descendant folders, recursively, of the given folder. The folder equivalent of "descendants of <folder>".Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
descendant of <folder><file>

Plural: descendants
Returns a list of all the descendant files of the specified folder.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
file <string> of <folder><file>

Plural: files
Returns a file object for the named file located in the folder.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
file of <folder><file>

Plural: files
Iterates through the files of a folder returning file objects. When combined with a whose clause you can select files with specific properties. See file.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
find file <string> of <folder><file>

Plural: find files
Iterates through the files of a folder returning file objects whose name matches the wildcard string provided in the name parameter. A wildcard string uses an asterisk to stand for any number of characters (incuding zero), and a question mark to stand for exactly one character. Thus A??.txt would match All.txt and AXE.txt but not all.txt or a.txt. See example below.Win, Lin, Sol, HPUX, AIX, Mac:8.0, WM, Ubu:8.1
find folder <string> of <folder><folder>

Plural: find folders
Finds the folder with the given wildcard name inside another folder. A wildcard string uses an asterisk to stand for any number of characters (incuding zero), and a question mark to stand for exactly one character. Thus A??.txt would match All.txt and AXE.txt but not all.txt or a.txt.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
folder <string> of <folder><folder>

Plural: folders
Returns a folder object for the named sub-folder. Trailing slashes should be omitted from the name.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
folder of <folder><folder>

Plural: folders
Iterates through the folders of a folder returning folder objects. When combined with a whose clause, you can select folders with specific properties.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
security descriptor of <folder><security descriptor>

Plural: security descriptors
Specifies the security descriptor associated with the specified folder.Win

drive

The <drive> object is available to inspect these aspects of the file system.

Creation Methods

DeclarationDescriptionPlatforms (?)
driveIterates through all valid drives on the system. Typically used to return a list of the drives (volumes, filesystems) on the client computer. On Windows computers, this returns a <drive> object.On *nix computers, this returns a <filesystem> object.Drives, volumes and filesystems are treated the same on the Macintosh and return a <volume> type.

Example:
names of drives - Returns a list of drives, eg., C:, D:, etcetera.

Example:
drives - Returns a list of drives, eg., /, /Users/MyUserName, and others.
Win, WM
drive <string>Returns the drive associated with the pathname specified by <string>. On Windows computers, this returns a <drive> object.On Macintosh computers, this returns a <volume> object.On *nix computers, this returns a <filesystem> object.

Example:
file count of drive "/etc/passwd" - Returns the total number of files on the drive containing the specified file.
Win, WM
drive of <filesystem object>Returns the drive associated with the specified file or folder (filesystem object).Win, WM

Properties

DeclarationReturn typeDescriptionPlatforms (?)
volume of <drive><string>

Plural: volumes
Returns the volume name of the drive if presentWin:9.0
file system type of <drive><string>

Plural: file system types
Value as reported by GetVolumeInformation.Win, WM
file_supports_encryption of <drive><boolean>

Plural: file_supports_encryptions
TRUE if bit is returned by GetVolumeInformation.Win, WM
file_supports_object_ids of <drive><boolean>

Plural: file_supports_object_idss
TRUE if bit is returned by GetVolumeInformation.Win, WM
file_supports_reparse_points of <drive><boolean>

Plural: file_supports_reparse_pointss
TRUE if bit is returned by GetVolumeInformation.Win, WM
file_supports_sparse_files of <drive><boolean>

Plural: file_supports_sparse_filess
TRUE if bit is returned by GetVolumeInformation.Win, WM
file_volume_quotas of <drive><boolean>

Plural: file_volume_quotass
TRUE if bit is returned by GetVolumeInformation.Win, WM
folder <string> of <drive><folder>

Plural: folders
Returns a folder object corresponding to the name given provided that folder exists on the drive.Win, WM
free space of <drive><integer>

Plural: free spaces
Returns the number of unused bytes of storage for the drive. (Only available for fixed disks).Win, WM
fs_case_is_preserved of <drive><boolean>

Plural: fs_case_is_preserveds
TRUE if bit is returned by GetVolumeInformation.Win, WM
fs_case_sensitive of <drive><boolean>

Plural: fs_case_sensitives
TRUE if bit is returned by GetVolumeInformation.Win, WM
fs_file_compression of <drive><boolean>

Plural: fs_file_compressions
TRUE if bit is returned by GetVolumeInformation.Win, WM
fs_persistent_acls of <drive><boolean>

Plural: fs_persistent_aclss
TRUE if bit is returned by GetVolumeInformation.Win, WM
fs_unicode_stored_on_disk of <drive><boolean>

Plural: fs_unicode_stored_on_disks
TRUE if bit is returned by GetVolumeInformation.Win, WM
fs_vol_is_compressed of <drive><boolean>

Plural: fs_vol_is_compresseds
TRUE if bit is returned by GetVolumeInformation.Win, WM
name of <drive><string>

Plural: names
Returns the name of the drive. Names look like 'c:' and 'D:'.Win, WM
numeric type of <drive><integer>

Plural: numeric types
Returns the type of drive as an integer.Win, WM
root folder of <drive><folder>

Plural: root folders
Returns the folder corresponding to the root of the drive.Win, WM
total space of <drive><integer>

Plural: total spaces
Returns the size in bytes of the drive. (Only available for fixed disks).Win, WM
type of <drive><string>

Plural: types
Returns the type of drive as a string.Win, WM

bundle

On HPUX platforms, a bundle object is derived from a product type and used to inspect software installations as managed by the Software Depot. On Macintosh platforms, a bundle refers to a core foundation folder hierarchy derived from CFBundle.

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

volume

The <volume> Inspectors refer to the mounted drive volumes.

Creation Methods

DeclarationDescriptionPlatforms (?)

Operators

DeclarationReturn TypeDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

file shortcut

Shortcuts to files can be constructed in the file system. The shortcut contains some additional properties that can be inspected.

Creation Methods

DeclarationDescriptionPlatforms (?)
shortcut of <file>Returns the properties and locates the target of a file shortcut:pathname (string)start in pathname (string)argument string (string)icon pathname (string)icon index (integer).

Example:
pathname of shortcut of file "BigFix.lnk" of (value "Common Desktop" of key "HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Explorer\Shell Folders" of registry as folder) - Returns the pathname associated with the shortcut.
Win

Properties

DeclarationReturn typeDescriptionPlatforms (?)
argument string of <file shortcut><string>

Plural: argument strings
Returns the arguments that are passed to the application to which the shortcut points when the user attempts to open the shortcut.Win
icon index of <file shortcut><integer>

Plural: icon indexes
The index number of the icon in the file containing the icon associated with the shortcut.Win
icon pathname of <file shortcut><string>

Plural: icon pathnames
The full pathname of the file containing the icon associated with the shortcut.Win
pathname of <file shortcut><string>

Plural: pathnames
Returns the full pathname of the object to which the shortcut points.Win
start in pathname of <file shortcut><string>

Plural: start in pathnames
Returns the full pathname the system sets the current directory when the user launches the shortcut.Win

file section

Many programs and utilities store their settings in 'ini' files. This object is designed to access these settings. An 'ini' file is composed of zero or more named sections, each with zero or more keys. Each key is identified by name and has a string value.

Creation Methods

DeclarationDescriptionPlatforms (?)
section <string> of <file>Returns a named section of a file. Useful for locating sections of 'ini' files. Section names are delimited by square bracket characters '[section name]'. See examples below.

Example:
exists Section "General" of file "oeminfo.ini" of system folder - Returns TRUE if a section named "General" appears in the named "ini" file.

Example:
key "Manufacturer" of section "General" of file "oeminfo.ini" of system folder - Returns the name of the computer manufacturer, such as "Dell Computer Corporation".

Example:
key "Manufacturer" of section "General" of file "/etc/oeminfo" - Returns the value of the "Manufacturer" key of the section named "General" of the specified file.

Example:
key "Manufacturer" of section "General" of file "/etc/oeminfo" - Returns the value of the "Manufacturer" key of the section named "General" of the specified file.
Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1

Properties

DeclarationReturn typeDescriptionPlatforms (?)
key <string> of <file section><string>

Plural: keys
Returns a string containing the value for the name provided. A case-insensitive search is performed through the section of the file.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1

file content

Content objects can be constructed from file objects to inspect their contents.

Creation Methods

DeclarationDescriptionPlatforms (?)
content of <file>Returns an object that can be used to search for a string in the file. See content.

Example:
content of file "oeminfo.ini" of system folder as lowercase contains "dell" - Returns TRUE if the specified file contains the string "dell" anywhere in the file.

Example:
content of file "oeminfo.ini" of system folder as lowercase contains "emachines" - Returns TRUE if either of the strings "emachines" or "eMachines" is found in the file.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<file content> as lowercaseReturns a lowercase version of the content provided.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<file content> as uppercaseReturns an uppercase version of the content provided.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

Operators

DeclarationReturn TypeDescriptionPlatforms (?)
<file content> contains <string><boolean>Returns TRUE if the string is located in the content provided.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

Properties

DeclarationReturn typeDescriptionPlatforms (?)
<file content> as lowercase<file content>Returns a lowercase version of the content provided.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<file content> as uppercase<file content>Returns an uppercase version of the content provided.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

version

This is the numeric method of indicating the file version, which is compact, convenient and fast. It makes use of a short string to define the version number. Version types are available as both client and core Inspectors, so if you don't find what you want in one guide, please check the other.

Creation Methods

DeclarationDescriptionPlatforms (?)
<string> as versionReturns a version if the string can be parsed as a version. The first numeric set of characters delimited with period, comma or comma-space is returned.Win, WM, Lin, Mac, HPUX, AIX, Sol, Ubu:8.1
version <string>Short hand for 'file version'.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
file version of <file>Returns the file version extracted from the file's resource block. See version.

Example:
file version of application "iexplore.exe" of the registry < "4" - Test for older version of IE -- returns TRUE is version is less than 4.
Win, WM
product version of <file>Returns the product version extracted from the file's resource block. See version.

Example:
product version of file "qna.exe" of parent folder of regapp "bigfix.exe" = product version of regapp "bigfix.exe" - Verifies the existence a co-executable located in the same folder with the proper version.

Example:
product version of regapp "bigfix.exe" > version "1.0.21" - Returns TRUE if the application has a version of 1.0.22 or higher, and FALSE if the application has a version of 1.0.21 or less.

Example:
product version of regapp "bigfix.exe" > version "1.0.21" - Returns TRUE if the application has a version of 1.0.22 or higher, and FALSE if the application has a version of 1.0.21 or less.
Win, WM
raw file version of <file>Returns the file version directly from a PE file.Win, WM
raw product version of <file>Returns the product version directly from a PE file.Win, WM
raw version of <file>Returns the version directly from a PE file.Win, WM
version of <file>Synonym for file version of <file>.

Example:
version of file (pathname of shortcut of file "BigFix.lnk" of folder "c:\Documents and Settings\All Users\Desktop") - Returns the version number of the application to which the shortcut points.
Win, Mac, WM
<string> as versionReturns a version if the string can be parsed as a version. The first numeric set of characters delimited with period, comma or comma-space is returned.Win, WM, Lin, Mac, HPUX, AIX, Sol, Ubu:8.1
<version> as versionReflexive cast of version.Win, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, WM, Ubu:8.1
maximum of <version>Returns the maximum value from a list of <version> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
minimum of <version>Returns the minimum value from a list of <version> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
pad of <version>Returns a version object which is padded with zero values.

Example:
pad of version "1.2" = version "1.2.0.0" - Returns TRUE.
Win, WM
version of <operating system>Returns the version of the operating system.Win:8.0, Lin:8.2, Sol:8.2, HPUX:8.2, AIX:8.2, Mac:8.0, Ubu:8.2
version of <service>This Inspector takes the specified service property and retrieves its version (file version).

Example:
version of service "BESClient" - Returns a version number, such as '8.0.584.0'.
Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
version of <current relay>Returns a version object that is the version of the server that the client last registered with. This may be a BES Relay or the BES root server.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
version of <application usage summary instance>Returns the version of the specified application instance.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1

Operators

DeclarationReturn TypeDescriptionPlatforms (?)
<version> {cmp} <string><boolean>Returns a boolean TRUE or FALSE, depending on the comparison operator, where:{cmp} is one of: =, !=, <, <=, >, >= .Win, Lin, Sol, HPUX, AIX, Mac, WM
<string> {cmp} <version><boolean>Returns a boolean TRUE or FALSE, depending on the comparison operator, where:{cmp} is one of: =, !=, <, <=, >, >= .Win, Lin, Sol, HPUX, AIX, Mac, WM
<string> {cmp} <version><boolean>Returns a boolean TRUE or FALSE, depending on the comparison operator, where:{cmp} is one of: =, !=, <, <=, >, >= .Win, Lin, Sol, HPUX, AIX, Mac, WM
<version> {cmp} <version><boolean>Returns a boolean TRUE or FALSE, depending on the comparison operator, where:{cmp} is one of: =, !=, <, <=, >, >= .Win, Lin, Sol, HPUX, AIX, Mac, WM

Properties

DeclarationReturn typeDescriptionPlatforms (?)
<string> as version<version>Returns a version if the string can be parsed as a version. The first numeric set of characters delimited with period, comma or comma-space is returned.Win, WM, Lin, Mac, HPUX, AIX, Sol, Ubu:8.1
<version> as string<string>Turns a version type into a string of the form "1.2.3.4".Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<version> as version<version>Reflexive cast of version.Win, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, WM, Ubu:8.1
extrema of <version><( version, version )>

Plural: extremas
Returns the minimum and maximum extreme values of the given list of <version> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
maximum of <version><version>

Plural: maxima
Returns the maximum value from a list of <version> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
minimum of <version><version>

Plural: minima
Returns the minimum value from a list of <version> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
pad of <version><version>

Plural: pads
Returns a version object which is padded with zero values.Win, WM
unique value of <version><version with multiplicity>

Plural: unique values
Returns the unique values of a given list of <version> types, removing duplicates and sorting by value.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

version with multiplicity

The <version with multiplicity> Inspectors deal with version arrays, allowing you to extract unique version values and count them.

Creation Methods

DeclarationDescriptionPlatforms (?)
unique value of <version>Returns the unique values of a given list of <version> types, removing duplicates and sorting by value.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

Properties

DeclarationReturn typeDescriptionPlatforms (?)
multiplicity of <version with multiplicity><integer>

Plural: multiplicities
Sorts the list and returns the multiplicity, or count, of each unique element in the specified list of multiple <version> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

file version block

You can inspect the version blocks of a file. There may be several language-specific version blocks. Version blocks contain version and name information in a human readable form for the specified language. This is the information that Windows displays in the file properties dialog. This technique uses string values and has a limited array of comparators. For better speed, utility and compactness see the version object.

Creation Methods

DeclarationDescriptionPlatforms (?)
first raw version block of <file>Returns the first version block directly from a PE file. If the first block is sufficient for your purposes, use this version inspector for best speed.Win, WM
only raw version block of <file>Returns the only version block directly from a PE file.Win, WM
only version block of <file>Most files only have 1 version block. This property allows language independent access when there is only one version block present. The result is the same as 'version block 1'.Win, WM
raw version block <integer> of <file>Returns the numbered version block directly from a PE file.Win, WM
raw version block <string> of <file>Returns the named version block directly from a PE file.Win, WM
raw version block of <file>Returns the version block directly from a PE file.Win, WM
version block <integer> of <file>You can identify the particular version block you want to access by ordinal number.

Example:
value "CompanyName" of version block 1 of regapp "bigfix.exe" = "BigFix Inc." - Returns TRUE if the "CompanyName" value of the given file's version block equals the specified string.
Win, WM
version block <string> of <file>You can identify the particular version block you are looking up by name. The name you provide should match the id string of the version block.

Example:
exists version block "040904B0" of regapp "bigfix.exe" - Returns TRUE if the designated version block exists. The case of the name of the version block is ignored.
Win, WM
version block of <file>Iterates through the version blocks of a file.Win, WM

Properties

DeclarationReturn typeDescriptionPlatforms (?)
codepage of <file version block><string>

Plural: codepages
A string representation of the codepage portion of the id of this version block. See notes for known codepage strings. For example, 'Unicode'.Win, WM
id of <file version block><string>

Plural: ids
A string representation containing both the language and codepage of this version block. The format is 8 hex digits, 4 of the codepage concatenated with 4 of the language. For example, '040904b0'. See notes for known values.Win, WM
language of <file version block><string>

Plural: languages
A string representation of the language portion of the id of this version block. For example, 'English (United States)'. See notes for known values.Win, WM
value <string> of <file version block><string>

Plural: values
Returns a string corresponding to the name provided. Values have names such as 'CompanyName', 'FileDescription', 'FileVersion'.Win, WM

strverscmp version

Uses the OS supplied strverscmp function, which may be useful for certain older-style version comparisons. For more information, see the man page for strverscmp.

Creation Methods

DeclarationDescriptionPlatforms (?)

Operators

DeclarationReturn TypeDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

domain

Mac OS X defines several file system domains to control access to system resources on multi-user systems. These include the User, Local, Network, Classic and System domains. The domain for a given resource or folder determines its accessibility to the user. For example, while a user-installed font is only available to that user, an administrator-installed font is available to all network users. These Inspectors allow folder access to be parceled out according to domain.Note: The "user domain" refers to the root user, not the currently logged in user.

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

mode

The <mode> inpector returns file type information and permissions. These are the possible values of mode:S_IFMT 170000 bitmask for the file type bitfieldsS_IFSOCK 140000 socketS_IFLNK 120000 symbolic linkS_IFREG 100000 regular fileS_IFBLK 060000 block deviceS_IFDIR 040000 directoryS_IFCHR 020000 character deviceS_IFIFO 010000 fifoS_ISUID 004000 set UID bitS_ISGID 002000 set GID bitS_ISVTX 001000 sticky bitS_IRWXU 000700 mask for file owner permissionsS_IRUSR 000400 owner has read permissionS_IWUSR 000200 owner has write permissionS_IXUSR 000100 owner has execute permissionS_IRWXG 000070 mask for group permissionsS_IRGRP 000040 group has read permissionS_IWGRP 000020 group has write permissionS_IXGRP 000010 group has execute permissionS_IRWXO 000007 mask for permissions for others (not in group)S_IROTH 000004 others have read permissionS_IWOTH 000002 others have write permissionS_IXOTH 000001 others have execute permission

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

mode_mask

The <mode_mask> Inspector is a differently formatted version of the mode, created by shifting the key information down to the low three bits.

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

file type

The <file type> Inspectors provide access to the four character file type associated with some types of files.

Creation Methods

DeclarationDescriptionPlatforms (?)

Operators

DeclarationReturn TypeDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

file signature

The <file signature> Inspectors provide access to each of the four character file signatures associated with some types of files.

Creation Methods

DeclarationDescriptionPlatforms (?)

Operators

DeclarationReturn TypeDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

component

Components are handled by the MacOS Component Manager. These Inspectors provide access to the various software components available through the Component Manager. The information contained in a component is placed there by its maker. How it should be interpreted is also determined by the maker.

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

datafork

The <datafork> Inspectors refer to the data fork of a filesystem object.

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

resfork

The <resfork> Inspectors refer to the resource fork of a filesystem object.

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

dictionaryentry

The <dictionaryentry> inspectors provide access to the entries of a dictionary.

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

dictionary

The <dictionary> Inspectors provide access to an XML dictionary as used in .plist (property list) files.

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

country

The <country> Inspectors allow comparing countries (as seen in version numbers).

Creation Methods

DeclarationDescriptionPlatforms (?)

Operators

DeclarationReturn TypeDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

osxvalue

The <osxvalue> Inspectors provide access to the elements of a dictionary.

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

preference

The <preference> Inspectors provide access to application preference files.

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

stage

The <stage> objects are for inspecting the stage portion of version numbers, which is the penultimate section of a version string: Major.Minor.ReleaseStageBuild.

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

fileset

The <fileset> objects represent the set of files required for installing a software package.

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

file line

A <file line> object produces strings from a text file.

Creation Methods

DeclarationDescriptionPlatforms (?)
line <integer> of <file>Returns the nth line (specified by <integer>) from the given file.

Example:
line 2 of (file "printmon.inf" of system folder) - Returns the second line of the specified file.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
line containing <string> of <file>Returns all lines from the given file that contain the specified string.

Example:
lines containing "Signature]" of file "mmdriver.inf" of system folder - Returns a list corresponding to the top-level sections involving signatures in the specified .inf file.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
line of <file>Iterates over all the lines of the specified file. Note that the lines are truncated to 1023 characters.

Example:
lines of file "c:\autoexec.bat" - Returns all the lines in the specified autoexec.bat file.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
line starting with <string> of <file>Same as line <string> of <file>, returns the lines of the given file that start with the specified string.

Example:
lines starting with "[" of file "mmdriver.inf" of system folder - Returns a list corresponding to all the top-level sections (lines that start with "[") in the specified .inf file.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
next line of <file line>Returns the line after the specified line in a file (provided that it is not the last line). This Inspector can be chained indefinitely, eg., next line of next line of ...

Example:
next line of line containing "[mciavi]" of file "mmdriver.inf" of system folder - Returns the line after the one containing "[mciavi]", which is a string such as "1:MSVFW32.DLL".
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
previous line of <file line>Returns the line before the nth line in a file, provided n>1. You may repeat this command up to three times.

Example:
previous line of previous line of previous line of line containing "[mciavi]" of file "mmdriver.inf" of system folder - Returns the line 3 lines previous to the one containing the specified phrase in the given file.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

Properties

DeclarationReturn typeDescriptionPlatforms (?)
line number of <file line><integer>

Plural: line numbers
Returns the line number of a given line. Can be used to locate specific lines in a file.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
next line of <file line><file line>

Plural: next lines
Returns the line after the specified line in a file (provided that it is not the last line). This Inspector can be chained indefinitely, eg., next line of next line of ...Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
previous line of <file line><file line>

Plural: previous lines
Returns the line before the nth line in a file, provided n>1. You may repeat this command up to three times.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

xml dom node

The <xml dom node> objects are the Inspectors for the XML Document Object Module (DOM) nodes. The console uses MSXML 6.0 if it is available. Otherwise it falls back to 4.0. The console requires at least 4.0 since 3.0 does not provide XML schema validation.

Creation Methods

DeclarationDescriptionPlatforms (?)
attribute <integer> of <xml dom node>Returns the numbered attribute of the specified XML DOM node.

Example:
node value of attribute 0 of child node 0 of xml document of file "icsxml\cmnicfg.xml" of system folder - Returns the value of the first attribute of the first node of the specified document.
Win, WM
attribute <string> of <xml dom node>Returns the named attribute of the specified node.

Example:
node value of attribute "xmlns" of child node 1 of xml document of (file "icsxml\cmnicfg.xml" of system folder) - Returns the value of the named attribute (xmlns) of the specified file.
Win, WM
attribute of <xml dom node>Returns the attribute(s) of the specified XML DOM node.

Example:
node names of attributes of child nodes of xml document of file "icsxml\cmnicfg.xml" of system folder - Returns the names of the attributes of each node in the specified file.
Win, WM
child node <integer> of <xml dom node>Returns the child node by number.

Example:
node names of child nodes of child node 1 of xml document of file "icsxml\cmnicfg.xml" of system folder - Returns a list of the names of the children of the first node in the specified document.
Win, WM
child node of <xml dom node>By chaining this Inspector, you can find the child nodes of any given node.

Example:
node names of child nodes of child node 1 of last child of xml document of file "icsxml\cmnicfg.xml" of system folder - Returns the names of the specified chain of child nodes.
Win, WM
first child of <xml dom node>Returns the first child node in the specified node. When applied to an XML DOM file, it returns the first node in the file.Win, WM
last child of <xml dom node>Returns the last child node in the specified node. When applied to an XML DOM file, it returns the last node in the file.Win, WM
next sibling of <xml dom node>Returns the next child node after the current one.

Example:
node name of next sibling of first child of xml document of file "icsxml\cmnicfg.xml" of system folder - Returns the name of the second node of the specified file.
Win, WM
parent node of <xml dom node>Returns the parent node of the specified node.Win, WM
previous sibling of <xml dom node>Returns the child node before the one specified.Win, WM
select <string> of <xml dom node>Uses an Xpath string to specify an XML DOM node. For instance, to select all elements BBB which are children of the root element AAA, use:selects "/AAA/BBB" of xml dom document <string>.Win, WM
xpath <( string, string )> of <xml dom node>The iterated named property xpaths (<namespace>, <query>) provides a way of specifying the namespaces for the query. If the XML document you are querying over uses namespaces, you must use them in the query and use this property.

Example:
xpath ( "xmlns:a='x-schema:bookschema.xml'", "/a:Books/a:Book" ) of xml document of file "c:\test.xml" as xml - Returns an xml dom node such as <a:Book xmlns:a="x-schema:bookschema.xml">%0d%0a%09<title>Presenting XML</title>%0d%0a%09<author>Richard Light</author>%0d%0a</a:Book>.
Win, WM
xpath <string> of <xml dom node>Returns an iterated list of matching xml dom nodes, given the xpath query specified by <string>.Win, WM

Properties

DeclarationReturn typeDescriptionPlatforms (?)
<xml dom node> as text<string>Casts an xml document object module node as text.Win, WM
<xml dom node> as xml<string>Casts an xml document object module node as xml.Win, WM
attribute <integer> of <xml dom node><xml dom node>

Plural: attributes
Returns the numbered attribute of the specified XML DOM node.Win, WM
attribute <string> of <xml dom node><xml dom node>

Plural: attributes
Returns the named attribute of the specified node.Win, WM
attribute of <xml dom node><xml dom node>

Plural: attributes
Returns the attribute(s) of the specified XML DOM node.Win, WM
child node <integer> of <xml dom node><xml dom node>

Plural: child nodes
Returns the child node by number.Win, WM
child node of <xml dom node><xml dom node>

Plural: child nodes
By chaining this Inspector, you can find the child nodes of any given node.Win, WM
first child of <xml dom node><xml dom node>

Plural: first children
Returns the first child node in the specified node. When applied to an XML DOM file, it returns the first node in the file.Win, WM
last child of <xml dom node><xml dom node>

Plural: last children
Returns the last child node in the specified node. When applied to an XML DOM file, it returns the last node in the file.Win, WM
next sibling of <xml dom node><xml dom node>

Plural: next siblings
Returns the next child node after the current one.Win, WM
node name of <xml dom node><string>

Plural: node names
Returns the name of the specified XML DOM node as a string.Win, WM
node type of <xml dom node><integer>

Plural: node types
Returns the numeric node type of the specified Document Object Module (DOM) node, 1-12 as shown in the creation Inspector.Win, WM
node value of <xml dom node><string>

Plural: node values
Returns the node value, which varies depending on the node type. If the standard interface produces a null type, the Inspector throws NoSuchObject.Win, WM
owner document of <xml dom node><xml dom document>

Plural: owner documents
Returns a document belonging to the owner of the specified node.Win, WM
parent node of <xml dom node><xml dom node>

Plural: parent nodes
Returns the parent node of the specified node.Win, WM
previous sibling of <xml dom node><xml dom node>

Plural: previous siblings
Returns the child node before the one specified.Win, WM
select <string> of <xml dom node><xml dom node>

Plural: selects
Uses an Xpath string to specify an XML DOM node. For instance, to select all elements BBB which are children of the root element AAA, use:selects "/AAA/BBB" of xml dom document <string>.Win, WM
xpath <( string, string )> of <xml dom node><xml dom node>

Plural: xpaths
The iterated named property xpaths (<namespace>, <query>) provides a way of specifying the namespaces for the query. If the XML document you are querying over uses namespaces, you must use them in the query and use this property.Win, WM
xpath <string> of <xml dom node><xml dom node>

Plural: xpaths
Returns an iterated list of matching xml dom nodes, given the xpath query specified by <string>.Win, WM

symlink

Symlinks, or symbolic links, are the Unix version of shortcut files (pointers to other files). Inspectors can analyze the file objects (files and folders) that symlinks point to by using the standard file Inspectors. The symlink Inspectors, on the other hand, allow you to analyze the properties of a symlink itself, not just the underlying file. There are many properties that symlinks have in common with files, such as name, pathname, parent folder, and more. In addition, a symlink has a value corresponding to the file object it points to. You can also determine if the file is available or not.

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

logical volume manager

On AIX, the logical volume manager provides a flexible means of allocating disk space using volume groups, logical volumes, and physical volumes. A volume group is a collection of one or more physical volumes and a logical volume is an abstraction representing a pool of disk space. The disk space assigned to a logical volume appears contiguous to the user, but it may actually be distributed across one or more physical volumes within a single volume group.

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

logical volume

A logical volume consists of an array of identically sized logical partitions. The partition size of a logical volume is determined by the volume group that contains it, and is the same as the volume group's physical partition size. Contiguous logical partitions within a logical volume may map to discontiguous physical partitions, possibly distributed across multiple physical volumes. A logical volume may be configured so that its logical partitions are mirrored to protect data from hardware failures. Mirroring may be configured so that each logical partition maps to either 2 or 3 physical partition mirrors.

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

volume group

On AIX systems, physical disk volumes are organized into volume groups. The partition size of a physical volume is determined by the volume group that it belongs to. If multiple physical volumes belong to the same volume group, then they must all have the same partition size. A typical partition size might be 16 or 32 megabytes.

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

download storage folder

Before an Action executes, the download storage folder points to a temporary directory that holds the downloads for the Action. During execution of the Action, those downloads are moved to the standard BigFix __Download folder and the Inspector then points there. These Inspectors return information about the currently specified download storage folder, and can be used with relevance substitution in download and prefetch Action commands.

Creation Methods

DeclarationDescriptionPlatforms (?)
download storage folderThis Inspector creates a pointer to the current download storage folder.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1

Properties

DeclarationReturn typeDescriptionPlatforms (?)
total size of <download storage folder><integer>

Plural: total sizes
Returns the amount of storage currently being used to store downloads (in bytes).Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1

device file

These Inspector types interrogate Unix-style device files, which contain device drivers or system resources. Unix identifies these resources by a major number and a minor number, both stored as part of a node structure. Typically, the major number identifies the device driver and the minor number identifies the particular device controlled by that driver.

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

fifo file

In Unix systems, a FIFO file is a named pipe that uses the file system as a way to store the pipe name. These Inspectors provide access to these named pipes.

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

socket file

The <socket file> Inspectors allow you to interrogate socket files, which are representations of UNIX domain sockets identified by their pathname.

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)